UInstant3DHubSettings Class Reference

UInstant3DHubSettings Class Reference#

instant3Dhub: UInstant3DHubSettings Class Reference
instant3Dhub

#include "Instant3DHubSettings.h"

Inheritance diagram for UInstant3DHubSettings:
Collaboration diagram for UInstant3DHubSettings:

Detailed Description

Project Settings for the Instant3DHub Unreal Plugin.

Public Member Functions

ECollisionEnabled::Type GetGeometryCollisionEnabled () const
ECollisionEnabled::Type GetDrawingCollisionEnabled () const

Static Public Member Functions

static const UInstant3DHubSettingsGet ()
static const UInstant3DHubSettingsGetChecked ()

Public Attributes

FKey RemoteCullerDebugImageKey = EKeys::F8
FName GeometryCollisionProfileName {TEXT("instant3DhubGeometry")}
FName DrawingCollisionProfileName {TEXT("instant3DhubDrawing")}

Member Function Documentation

◆ Get()

const UInstant3DHubSettings * UInstant3DHubSettings::Get ( )
inlinestatic

Gets the instant3Dhub Unreal Plugin Settings.

Returns
A Pointer to the instant3Dhub Settings.

◆ GetChecked()

const UInstant3DHubSettings & UInstant3DHubSettings::GetChecked ( )
inlinestatic

Gets the instant3Dhub Unreal Plugin Settings.

Returns
A Reference of the instant3Dhub Settings.

◆ GetDrawingCollisionEnabled()

ECollisionEnabled::Type UInstant3DHubSettings::GetDrawingCollisionEnabled ( ) const

Retrieves the CollisionEnabled Type from the Drawing Collision Profile.

Returns
The CollisionEnabled Type.

◆ GetGeometryCollisionEnabled()

ECollisionEnabled::Type UInstant3DHubSettings::GetGeometryCollisionEnabled ( ) const

Retrieves the CollisionEnabled Type from the Geometry Collision Profile.

Returns
The CollisionEnabled Type.

Member Data Documentation

◆ DrawingCollisionProfileName

FName UInstant3DHubSettings::DrawingCollisionProfileName {TEXT("instant3DhubDrawing")}

The geometry collision profile name that is used by instant3Dhub Drawings.

Note
Can only be changed via Config for compatibility with Unreal Collision Profiles.

◆ GeometryCollisionProfileName

FName UInstant3DHubSettings::GeometryCollisionProfileName {TEXT("instant3DhubGeometry")}

The geometry collision profile name that is used by instant3Dhub Geometry.

Note
Can only be changed via Config for compatibility with Unreal Collision Profiles.

◆ RemoteCullerDebugImageKey

FKey UInstant3DHubSettings::RemoteCullerDebugImageKey = EKeys::F8

This key toggles a debug overlay on and off, which streams in a debug image from the remote culler.

If pressed while the shift key is held down, it cycles through different modes of the debug overlay. Set to None to disable this feature.


The documentation for this class was generated from the following file: